/* Arduino Sd2Card Library
* Copyright (C) 2009 by William Greiman
*
* This file is part of the Arduino Sd2Card Library
*
* This Library is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This Library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with the Arduino Sd2Card Library.  If not, see
* <http://www.gnu.org/licenses/>.
*/
#include <WProgram.h>
#include "Sd2Card.h"
#include "HardwareSPI.h"
#include "spi.h"

//pointer to spi object
HardwareSPI *SPIx;

//------------------------------------------------------------------------------
// functions for hardware SPI
/** Send a byte to the card */
static void spiSend(uint8 b) 
{
	SPIx->send(b);
	//while(SPIx->busy())
	//{
	//}
}
/** Receive a byte from the card */
static  uint8 spiRec(void) 
{
	return SPIx->send(0XFF);
	//	return SPIx->read();
}

//------------------------------------------------------------------------------
// send command and return error code.  Return zero for OK
uint8 Sd2Card::cardCommand(uint8 cmd, uint32 arg) {
	// end read if in partialBlockRead mode
	readEnd();

	// select card
	chipSelectLow();

	// wait up to 300 ms if busy
	waitNotBusy(300);

	// send command
	spiSend(cmd | 0x40);

	// send argument
	for (int8_t s = 24; s >= 0; s -= 8) 
		spiSend(arg >> s);

	// send CRC
	uint8 crc = 0XFF;
	if (cmd == CMD0) crc = 0X95;  // correct crc for CMD0 with arg 0
	if (cmd == CMD8) crc = 0X87;  // correct crc for CMD8 with arg 0X1AA
	spiSend(crc);

	// wait for response
	for (uint8 i = 0; ((status_ = spiRec()) & 0X80) && i != 0XFF; i++);
	return status_;
}
//------------------------------------------------------------------------------
/**
* Determine the size of an SD flash memory card.
*
* \return The number of 512 byte data blocks in the card
*         or zero if an error occurs.
*/
uint32 Sd2Card::cardSize(void) {
	csd_t csd;
	if (!readCSD(&csd)) return 0;
	if (csd.v1.csd_ver == 0) {
		uint8 read_bl_len = csd.v1.read_bl_len;
		uint16 c_size = (csd.v1.c_size_high << 10)
			| (csd.v1.c_size_mid << 2) | csd.v1.c_size_low;
		uint8 c_size_mult = (csd.v1.c_size_mult_high << 1)
			| csd.v1.c_size_mult_low;
		return (uint32)(c_size + 1) << (c_size_mult + read_bl_len - 7);
	} else if (csd.v2.csd_ver == 1) {
		uint32 c_size = ((uint32)csd.v2.c_size_high << 16)
			| (csd.v2.c_size_mid << 8) | csd.v2.c_size_low;
		return (c_size + 1) << 10;
	} else {
		error(SD_CARD_ERROR_BAD_CSD);
		return 0;
	}
}
//------------------------------------------------------------------------------
void Sd2Card::chipSelectHigh(void) 
{
	digitalWrite(10, HIGH);
}

//------------------------------------------------------------------------------
void Sd2Card::chipSelectLow(void) 
{
	digitalWrite(10, LOW);
}

//------------------------------------------------------------------------------
/** Erase a range of blocks.
*
* \param[in] firstBlock The address of the first block in the range.
* \param[in] lastBlock The address of the last block in the range.
*
* \note This function requests the SD card to do a flash erase for a
* range of blocks.  The data on the card after an erase operation is
* either 0 or 1, depends on the card vendor.  The card must support
* single block erase.
*
* \return The value one, true, is returned for success and
* the value zero, false, is returned for failure.
*/
uint8 Sd2Card::erase(uint32 firstBlock, uint32 lastBlock) 
{
	if (!eraseSingleBlockEnable()) 
	{
		error(SD_CARD_ERROR_ERASE_SINGLE_BLOCK);
		SerialUSB.println("Error: Erase Single Block");
		goto fail;
	}
	if (type_ != SD_CARD_TYPE_SDHC) 
	{
		firstBlock <<= 9;
		lastBlock <<= 9;
	}
	if (cardCommand(CMD32, firstBlock)
		|| cardCommand(CMD33, lastBlock)
		|| cardCommand(CMD38, 0)) 
	{
		error(SD_CARD_ERROR_ERASE);
		SerialUSB.println("Error: Erase");
		goto fail;
	}
	if (!waitNotBusy(SD_ERASE_TIMEOUT)) 
	{
		error(SD_CARD_ERROR_ERASE_TIMEOUT);
		SerialUSB.println("Error: Erase timeout");
		goto fail;
	}
	chipSelectHigh();
	return true;

fail:
	chipSelectHigh();
	SerialUSB.println("Error: Sd2Card::Erase()");
	return false;
}
//------------------------------------------------------------------------------
/** Determine if card supports single block erase.
*
* \return The value one, true, is returned if single block erase is supported.
* The value zero, false, is returned if single block erase is not supported.
*/
uint8 Sd2Card::eraseSingleBlockEnable(void) 
{
	csd_t csd;
	return readCSD(&csd) ? csd.v1.erase_blk_en : 0;
}
//------------------------------------------------------------------------------
/**
* Initialize an SD flash memory card.
*
* \param[in] sckRateID SPI clock rate selector. See setSckRate().
* \param[in] chipSelectPin SD chip select pin number.
*
* \return The value one, true, is returned for success and
* the value zero, false, is returned for failure.  The reason for failure
* can be determined by calling errorCode() and errorData().
*/
uint8 Sd2Card::init(HardwareSPI *spi)
{
	errorCode_ = inBlock_ = partialBlockRead_ = type_ = 0;
	// 16-bit init start time allows over a minute

	uint32 t0 = millis();
	uint32 arg;

	pinMode(10,OUTPUT);

	SPIx = spi;

	chipSelectHigh();
	for (uint8 i = 0; i < 10; i++)
		spiSend(0XFF);
	chipSelectLow();

	// command to go idle in SPI mode
	while ((status_ = cardCommand(CMD0, 0)) != R1_IDLE_STATE)
	{
		if ((millis() - t0) > SD_INIT_TIMEOUT)
		{
			error(SD_CARD_ERROR_CMD0);
			goto fail;
		}
	}

	// check SD version
	if ((cardCommand(CMD8, 0x1AA) & R1_ILLEGAL_COMMAND)) 
	{
		type(SD_CARD_TYPE_SD1);
	} 
	else 
	{
		// only need last byte of r7 response
		for (uint8 i = 0; i < 4; i++) 
			status_ = spiRec();

		if (status_ != 0XAA) 
		{
			error(SD_CARD_ERROR_CMD8);
			goto fail;
		}
		type(SD_CARD_TYPE_SD2);
	}

	// initialize card and send host supports SDHC if SD2
	arg = (type() == SD_CARD_TYPE_SD2) ? 0X40000000 : 0;

	while ((status_ = cardAcmd(ACMD41, arg)) != R1_READY_STATE) 
	{
		// check for timeout
		if ((millis() - t0) > SD_INIT_TIMEOUT)
		{
			error(SD_CARD_ERROR_ACMD41);
			goto fail;
		}
	}

	// if SD2 read OCR register to check for SDHC card
	if (type() == SD_CARD_TYPE_SD2) 
	{
		if (cardCommand(CMD58, 0)) 
		{
			error(SD_CARD_ERROR_CMD58);
			goto fail;
		}

		if ((spiRec() & 0XC0) == 0XC0) 
			type(SD_CARD_TYPE_SDHC);

		// discard rest of ocr - contains allowed voltage range
		for (uint8 i = 0; i < 3; i++) 
			spiRec();
	}
	chipSelectHigh();
	return true;

fail:
	chipSelectHigh();
	return false;
}

//------------------------------------------------------------------------------
/**
* Enable or disable partial block reads.
*
* Enabling partial block reads improves performance by allowing a block
* to be read over the SPI bus as several sub-blocks.  Errors may occur
* if the time between reads is too long since the SD card may timeout.
* The SPI SS line will be held low until the entire block is read or
* readEnd() is called.
*
* Use this for applications like the Adafruit Wave Shield.
*
* \param[in] value The value TRUE (non-zero) or FALSE (zero).)
*/
void Sd2Card::partialBlockRead(uint8 value) 
{
	readEnd();
	partialBlockRead_ = value;
}
//------------------------------------------------------------------------------
/**
* Read a 512 byte block from an SD card device.
*
* \param[in] block Logical block to be read.
* \param[out] dst Pointer to the location that will receive the data.

* \return The value one, true, is returned for success and
* the value zero, false, is returned for failure.
*/
uint8 Sd2Card::readBlock(uint32 block, uint8* dst) 
{
	return readData(block, 0, 512, dst);
}
//------------------------------------------------------------------------------
/**
* Read part of a 512 byte block from an SD card.
*
* \param[in] block Logical block to be read.
* \param[in] offset Number of bytes to skip at start of block
* \param[out] dst Pointer to the location that will receive the data.
* \param[in] count Number of bytes to read
* \return The value one, true, is returned for success and
* the value zero, false, is returned for failure.
*/
uint8 Sd2Card::readData(uint32 block,
	uint16 offset, uint16 count, uint8* dst) 
{
	if (count == 0)
		return true;

	if ((count + offset) <= 512)
	{
		if (!inBlock_ || block != block_ || offset < offset_)
		{
			block_ = block;
			// use address if not SDHC card
			if (type()!= SD_CARD_TYPE_SDHC) 
				block <<= 9;

			if (cardCommand(CMD17, block)) 
			{
				error(SD_CARD_ERROR_CMD17);
				goto fail;
			}

			if (!waitStartBlock()) 
				goto fail;

			offset_ = 0;
			inBlock_ = 1;
		}

		// skip data before offset
		for (;offset_ < offset; offset_++)
			spiRec();

		// transfer data
		for (uint16 i = 0; i < count; i++)
			dst[i] = spiRec();

		offset_ += count;
		if (!partialBlockRead_ || offset_ >= 512)
			// read rest of data, checksum and set chip select high
			readEnd();

		return true;
	}

fail:
	chipSelectHigh();
	return false;
}
//------------------------------------------------------------------------------
/** Skip remaining data in a block when in partial block read mode. */
void Sd2Card::readEnd(void) 
{
	if (inBlock_) 
	{
		// skip data and crc
		while (offset_++ < 514)
			spiRec();

		chipSelectHigh();
		inBlock_ = 0;
	}
}
//------------------------------------------------------------------------------
/** read CID or CSR register */
uint8 Sd2Card::readRegister(uint8 cmd, void* buf) 
{
	uint8* dst = reinterpret_cast<uint8*>(buf);
	if (cardCommand(cmd, 0))
	{
		error(SD_CARD_ERROR_READ_REG);
	}
	else
	{
		if (waitStartBlock())
		{
			// transfer data
			for (uint16 i = 0; i < 16; i++)
				dst[i] = spiRec();

			spiRec();  // get first CRC byte
			spiRec();  // get second CRC byte
			chipSelectHigh();
			return true;
		}
	}

	chipSelectHigh();
	return false;
}

/*
 * Set the SPI clock rate.
 */
uint8 Sd2Card::setSckRate(uint8 sckRateID) {
	return true;
}

/*
 *	wait for card to go not busy
 */
uint8 Sd2Card::waitNotBusy(uint32 timeoutMillis) 
{
	uint32 t0 = millis();
	do 
	{
		if (spiRec() == 0XFF) 
			return true;
	}
	while ((millis() - t0) < timeoutMillis);
	return false;
}
//------------------------------------------------------------------------------
/** Wait for start block token */
uint8 Sd2Card::waitStartBlock(void) 
{
	uint16 t0 = millis();
	while ((status_ = spiRec()) == 0XFF) 
	{
		if (((uint16)millis() - t0) > SD_READ_TIMEOUT) 
		{
			error(SD_CARD_ERROR_READ_TIMEOUT);
			SerialUSB.println("Error: Read timeout");
			goto fail;
		}
	}
	if (status_ != DATA_START_BLOCK) 
	{
		error(SD_CARD_ERROR_READ);
		SerialUSB.println("Error: Read");
		goto fail;
	}
	return true;

fail:
	chipSelectHigh();
	SerialUSB.println("Error: Sd2Card::waitStartBlock()");
	return false;
}
//------------------------------------------------------------------------------
/**
* Writes a 512 byte block to an SD card.
*
* \param[in] blockNumber Logical block to be written.
* \param[in] src Pointer to the location of the data to be written.
* \return The value one, true, is returned for success and
* the value zero, false, is returned for failure.
*/
uint8 Sd2Card::writeBlock(uint32 blockNumber, const uint8* src) 
{
#if SD_PROTECT_BLOCK_ZERO
	// don't allow write to first block
	if (blockNumber == 0) 
	{
		error(SD_CARD_ERROR_WRITE_BLOCK_ZERO);
		SerialUSB.println("Error: Write block zero");
		goto fail;
	}
#endif  // SD_PROTECT_BLOCK_ZERO

	// use address if not SDHC card
	if (type() != SD_CARD_TYPE_SDHC) 
		blockNumber <<= 9;
	if (cardCommand(CMD24, blockNumber)) 
	{
		SerialUSB.println("Error: CMD42");
		error(SD_CARD_ERROR_CMD24);
		goto fail;
	}
	if (!writeData(DATA_START_BLOCK, src)) 
		goto fail;

	// wait for flash programming to complete
	if (!waitNotBusy(SD_WRITE_TIMEOUT)) 
	{
		error(SD_CARD_ERROR_WRITE_TIMEOUT);
		SerialUSB.println("Error: Write timeout");
		goto fail;
	}
	// response is r2 so get and check two bytes for nonzero
	if (cardCommand(CMD13, 0) || spiRec()) 
	{
		error(SD_CARD_ERROR_WRITE_PROGRAMMING);
		SerialUSB.println("Error: Write programming");
		goto fail;
	}
	chipSelectHigh();
	return true;

fail:
	chipSelectHigh();
	SerialUSB.println("Error: Sd2Card::writeBlock");
	return false;
}
//------------------------------------------------------------------------------
/** Write one data block in a multiple block write sequence */
uint8 Sd2Card::writeData(const uint8* src) 
{
	// wait for previous write to finish
	if (!waitNotBusy(SD_WRITE_TIMEOUT)) 
	{
		error(SD_CARD_ERROR_WRITE_MULTIPLE);
		SerialUSB.println("Error: writeData");
		chipSelectHigh();
		return false;
	}
	return writeData(WRITE_MULTIPLE_TOKEN, src);
}
//------------------------------------------------------------------------------
// send one block of data for write block or write multiple blocks
uint8 Sd2Card::writeData(uint8 token, const uint8* src) {
#ifdef OPTIMIZE_HARDWARE_SPI
	/*
	// send data - optimized loop
	SPDR = token;

	// send two byte per iteration
	for (uint16 i = 0; i < 512; i += 2) {
	while (!(SPSR & (1 << SPIF)));
	SPDR = src[i];
	while (!(SPSR & (1 << SPIF)));
	SPDR = src[i+1];
	}

	// wait for last data byte
	while (!(SPSR & (1 << SPIF)));
	*/
#else  // OPTIMIZE_HARDWARE_SPI
	spiSend(token);
	for (uint16 i = 0; i < 512; i++) 
	{
		spiSend(src[i]);
	}
#endif  // OPTIMIZE_HARDWARE_SPI
	spiSend(0xff);  // dummy crc
	spiSend(0xff);  // dummy crc

	status_ = spiRec();
	if ((status_ & DATA_RES_MASK) != DATA_RES_ACCEPTED) 
	{
		error(SD_CARD_ERROR_WRITE);
		chipSelectHigh();
		SerialUSB.println("Error: Write");
		SerialUSB.println("Error: Sd2Card::writeData()");
		return false;
	}
	return true;
}
//------------------------------------------------------------------------------
/** Start a write multiple blocks sequence.
*
* \param[in] blockNumber Address of first block in sequence.
* \param[in] eraseCount The number of blocks to be pre-erased.
*
* \note This function is used with writeData() and writeStop()
* for optimized multiple block writes.
*
* \return The value one, true, is returned for success and
* the value zero, false, is returned for failure.
*/
uint8 Sd2Card::writeStart(uint32 blockNumber, uint32 eraseCount) 
{
#if SD_PROTECT_BLOCK_ZERO
	// don't allow write to first block
	if (blockNumber == 0) 
	{
		error(SD_CARD_ERROR_WRITE_BLOCK_ZERO);
		SerialUSB.println("Error: Write block zero");
		goto fail;
	}
#endif  // SD_PROTECT_BLOCK_ZERO
	// send pre-erase count
	if (cardAcmd(ACMD23, eraseCount)) 
	{
		SerialUSB.println("Error: ACMD23");
		error(SD_CARD_ERROR_ACMD23);
		goto fail;
	}
	// use address if not SDHC card
	if (type() != SD_CARD_TYPE_SDHC) 
		blockNumber <<= 9;
	if (cardCommand(CMD25, blockNumber)) 
	{
		error(SD_CARD_ERROR_CMD25);
		SerialUSB.println("Error: CMD25");
		goto fail;
	}
	return true;

fail:
	chipSelectHigh();
	SerialUSB.println("Error: Sd2Card::writeStart()");
	return false;
}
//------------------------------------------------------------------------------
/** End a write multiple blocks sequence.
*
* \return The value one, true, is returned for success and
* the value zero, false, is returned for failure.
*/
uint8 Sd2Card::writeStop(void) 
{
	if (!waitNotBusy(SD_WRITE_TIMEOUT)) 
		goto fail;
	spiSend(STOP_TRAN_TOKEN);
	if (!waitNotBusy(SD_WRITE_TIMEOUT)) 
		goto fail;
	chipSelectHigh();
	return true;

fail:
	error(SD_CARD_ERROR_STOP_TRAN);
	chipSelectHigh();
	SerialUSB.println("Error: Sd2Card::writeStop()");
	return false;
}
